[User Storage Service] browser client, React hooks, injection rendering by tsullivan · Pull Request #268312 · elastic/kibana

tsullivan · 2026-05-07T21:41:42Z

Epic: https://github.com/elastic/kibana-team/issues/2769

Summary

Adds the browser foundation for the Core User Storage service (Step 2 of the project; the server-side foundation landed in #256912).

Three pieces:

A. Server-rendered injection.

RenderingServicepre-fetches the current user's stored values per request viauserStorage.asScoped(request).getAll()and inlines them under a newuserStorage.valuesfield on`.
Bounded by a 50ms timeout (mirroring the existing clusterInfo pattern at rendering_service.tsx:234)
skipped for anonymous pages and when asScoped returns null (no profile_uid).

B. Browser client.

Three new packages in src/core/packages/user-storage/:
1. @kbn/core-user-storage-browser (public API: IUserStorageClient, UserStorageProvider, useUserStorage, useUserStorageClient)
2. @kbn/core-user-storage-browser-internal (UserStorageService, UserStorageClient, UserStorageApi)
3. @kbn/core-user-storage-browser-mocks.
The client seeds an in-memory cache from injected metadata at boot, so get(key) is synchronous at first paint. set/remove write through HTTP and refresh the cache on success.
Architectural diagram

C. React hook + provider.

useUserStorage(key, default) returns [value, setter] with an Observable-backed subscription, and throws a helpful error when used outside <UserStorageProvider>.
useUserStorageClient() is the escape hatch for consumers that depend on remove, getUpdate$, and getUpdateErrors$.

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

~~[ ] Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
~~[ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list~~
[ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
~~[ ] Flaky Test Runner was used on any tests changed~~
The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines
Review the backport guidelines and apply applicable backport:* labels.

tsullivan · 2026-05-07T23:05:02Z

/ci

tsullivan · 2026-05-08T05:28:52Z

/ci

infra-vault-gh-plugin-prod · 2026-05-08T16:55:40Z

Pinging @elastic/appex-sharedux (Team:SharedUX)

tsullivan · 2026-05-08T21:32:15Z

Back to draft to add more Scout tests

Dosant

AI-generated review posted by @Dosant. I re-reviewed the updated PR after the recent fixes and focused on remaining behavioral/test issues. One additional note that I could not anchor directly: null currently acts as the server-side removal tombstone, but schemas can still allow null; if null is reserved for removal, registration/write validation should probably reject nullable schemas or the removal representation should change.

Dosant · 2026-05-22T09:22:15Z

+};
+
+export const App = ({ userStorage }: { userStorage: IUserStorageClient }) => (
+  <UserStorageProvider userStorage={userStorage}>


Maybe not necessarily in this PR - but I think we can include this provider into our core addContext thing so that apps can access the service without even requiring using the provider directly (similar to what we did to chrome service context)

Wrote this as a note to myself. It would probably merit attention if it does come up as a request.

kibanamachine · 2026-05-22T21:41:18Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: c46bbf9
Build duration: 66 mins

Failed CI Steps

Test Failures

[job] [logs] FTR Configs #124 / Entity Analytics - Watchlists @ess @serverless @skipInServerlessMKI Watchlist Lifecycle should remove all entities from the watchlist index when the watchlist is deleted
[job] [logs] Scout Lane #46 - serverless-observability_complete / default / local-serverless-observability_complete - Hosts Page - Empty State - should show onboarding page when no data is present

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`core`	668	673	+5

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`ml`	5.6MB	5.6MB	+26.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`core`	532.7KB	535.6KB	+2.9KB

History

💔 Build #447128 failed 0a19ba2
💔 Build #447098 failed 0e65c22
💛 Build #446591 was flaky 910eada
💔 Build #446480 failed bfe43d7
💔 Build #445964 failed 5fda572

…ng (elastic#268312) Epic: elastic/kibana-team#2769 ## Summary Adds the browser foundation for the Core User Storage service (Step 2 of the project; the server-side foundation landed in elastic#256912). Three pieces: **A. Server-rendered injection.** - RenderingService` pre-fetches the current user's stored values per request via `userStorage.asScoped(request).getAll()` and inlines them under a new `userStorage.values` field on `<kbn-injected-metadata>`. - Bounded by a 50ms timeout (mirroring the existing `clusterInfo` pattern at `rendering_service.tsx:234`) - skipped for anonymous pages and when `asScoped` returns `null` (no `profile_uid`). **B. Browser client.** - Three new packages in `src/core/packages/user-storage/`: 1. `@kbn/core-user-storage-browser` (public API: `IUserStorageClient`, `UserStorageProvider`, `useUserStorage`, `useUserStorageClient`) 2. `@kbn/core-user-storage-browser-internal` (`UserStorageService`, `UserStorageClient`, `UserStorageApi`) 3. `@kbn/core-user-storage-browser-mocks`. - The client seeds an in-memory cache from injected metadata at boot, so `get(key)` is synchronous at first paint. `set`/`remove` write through HTTP and refresh the cache on success. - Architectural diagram <img width="1295" height="631" alt="image" src="https://github.com/user-attachments/assets/0b3e9113-9ef1-47d7-8f7d-37bf8730e432" /> **C. React hook + provider.** - `useUserStorage(key, default)` returns `[value, setter]` with an Observable-backed subscription, and throws a helpful error when used outside `<UserStorageProvider>`. - `useUserStorageClient()` is the escape hatch for consumers that depend on `remove`, `getUpdate$`, and `getUpdateErrors$`. ## Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - ~[ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)~ - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - ~[ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)~ - ~[ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations.~ - ~[ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed~ - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Anton Dosov <anton.dosov@elastic.co>

…ng (#268312) Epic: elastic/kibana-team#2769 ## Summary Adds the browser foundation for the Core User Storage service (Step 2 of the project; the server-side foundation landed in #256912). Three pieces: **A. Server-rendered injection.** - RenderingService` pre-fetches the current user's stored values per request via `userStorage.asScoped(request).getAll()` and inlines them under a new `userStorage.values` field on `<kbn-injected-metadata>`. - Bounded by a 50ms timeout (mirroring the existing `clusterInfo` pattern at `rendering_service.tsx:234`) - skipped for anonymous pages and when `asScoped` returns `null` (no `profile_uid`). **B. Browser client.** - Three new packages in `src/core/packages/user-storage/`: 1. `@kbn/core-user-storage-browser` (public API: `IUserStorageClient`, `UserStorageProvider`, `useUserStorage`, `useUserStorageClient`) 2. `@kbn/core-user-storage-browser-internal` (`UserStorageService`, `UserStorageClient`, `UserStorageApi`) 3. `@kbn/core-user-storage-browser-mocks`. - The client seeds an in-memory cache from injected metadata at boot, so `get(key)` is synchronous at first paint. `set`/`remove` write through HTTP and refresh the cache on success. - Architectural diagram <img width="1295" height="631" alt="image" src="https://github.com/user-attachments/assets/0b3e9113-9ef1-47d7-8f7d-37bf8730e432" /> **C. React hook + provider.** - `useUserStorage(key, default)` returns `[value, setter]` with an Observable-backed subscription, and throws a helpful error when used outside `<UserStorageProvider>`. - `useUserStorageClient()` is the escape hatch for consumers that depend on `remove`, `getUpdate$`, and `getUpdateErrors$`. ## Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - ~[ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)~ - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - ~[ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)~ - ~[ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations.~ - ~[ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed~ - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Anton Dosov <anton.dosov@elastic.co>

tsullivan and others added 6 commits May 7, 2026 13:30

[User Storage Service] browser-side client and React hooks

fee3b2f

rendering integration: add initial values to HTML to prime the client

d99db24

optimize objectsToFetch in server client

3705dfd

comment simplification

b2fb0bd

type check fix

052c487

Changes from node scripts/lint.js --fix

ed7ddd3

tsullivan added reviewer:macroscope PR review with Macroscope release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting labels May 7, 2026

tsullivan added 2 commits May 7, 2026 15:27

update CODEOWNERS

7c49125

roll back unrelated optimization

1308d1c

kibanamachine added 2 commits May 7, 2026 23:15

Changes from node scripts/lint_ts_projects --fix

de77277

Changes from node scripts/regenerate_moon_projects.js --update

22e8d13

tsullivan commented May 8, 2026

View reviewed changes

Comment thread src/core/packages/user-storage/browser/src/user_storage_provider.tsx Outdated

tsullivan added 3 commits May 7, 2026 19:35

rename provider prop

463d71c

[User Storage] Add documentation

90b1ff7

cleanup

a9ecfb0

tsullivan added the Team:SharedUX Platform AppEx-SharedUX (formerly Global Experience) t// label May 8, 2026

tsullivan marked this pull request as ready for review May 8, 2026 16:55

tsullivan requested review from a team as code owners May 8, 2026 16:55

Merge branch 'main' into user-storage/browser-client

c424548

tsullivan marked this pull request as draft May 8, 2026 21:32

tsullivan requested a review from a team May 8, 2026 21:32

tsullivan added 2 commits May 8, 2026 16:39

Merge branch 'main' into user-storage/browser-client

c3798a8

scout - plugin test

e1b7da5

csr approved these changes May 19, 2026

View reviewed changes

Merge branch 'main' into user-storage/browser-client

aa5bad2

tsullivan requested a review from a team May 19, 2026 23:34

tsullivan mentioned this pull request May 20, 2026

[Side Nav] Customizable navigation #270276

Draft

5 tasks

Merge branch 'main' into user-storage/browser-client

5fda572

Dosant reviewed May 21, 2026

View reviewed changes

Comment thread src/core/packages/user-storage/common/src/types.ts Outdated

Dosant reviewed May 21, 2026

View reviewed changes

Comment thread src/core/packages/user-storage/server-internal/src/routes/index.ts

Comment thread src/core/packages/user-storage/browser/src/use_user_storage.ts Outdated

Comment thread src/core/packages/user-storage/test/scout_user_storage/ui/tests/render.spec.ts

tsullivan added 6 commits May 21, 2026 09:28

Merge branch 'main' into user-storage/browser-client

967884f

rename: serverInject -> preload

c215f23

use lazy value in scout functional test

fcba20b

schema not allow null

5d6fa66

add peek to the API to return cached value without lazy fetch

5ce9212

fix api tests for per-key fetch

bfe43d7

tsullivan requested review from a team and Dosant May 21, 2026 18:32

tsullivan added 2 commits May 21, 2026 13:05

fix types for jest test

e49e3f9

fix scout ui test

910eada

Dosant approved these changes May 22, 2026

View reviewed changes

tsullivan added 5 commits May 22, 2026 10:45

Merge branch 'main' into user-storage/browser-client

bf5946b

return parsed value from PUT and use it for browser cache

0e65c22

disallow undefined as allowed value in registration

bc289b4

fix type: set doesn't return Promise<void>

0a19ba2

update limits

c46bbf9

TamerlanG approved these changes May 23, 2026

View reviewed changes

tsullivan merged commit cfa774e into elastic:main May 23, 2026
37 checks passed

kibanamachine added the v9.5.0 label May 23, 2026

tsullivan deleted the user-storage/browser-client branch May 26, 2026 16:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[User Storage Service] browser client, React hooks, injection rendering#268312

[User Storage Service] browser client, React hooks, injection rendering#268312
tsullivan merged 51 commits into
elastic:mainfrom
tsullivan:user-storage/browser-client

tsullivan commented May 7, 2026 •

edited

Loading

Uh oh!

tsullivan commented May 7, 2026

Uh oh!

Uh oh!

tsullivan commented May 8, 2026

Uh oh!

infra-vault-gh-plugin-prod Bot commented May 8, 2026

Uh oh!

tsullivan commented May 8, 2026

Uh oh!

Uh oh!

Dosant left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Dosant May 22, 2026

Uh oh!

tsullivan May 22, 2026

Uh oh!

Uh oh!

Uh oh!

kibanamachine commented May 22, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Conversation

tsullivan commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

tsullivan commented May 7, 2026

Uh oh!

Uh oh!

tsullivan commented May 8, 2026

Uh oh!

infra-vault-gh-plugin-prod Bot commented May 8, 2026

Uh oh!

tsullivan commented May 8, 2026

Uh oh!

Uh oh!

Dosant left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Dosant May 22, 2026

Choose a reason for hiding this comment

Uh oh!

tsullivan May 22, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kibanamachine commented May 22, 2026

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

tsullivan commented May 7, 2026 •

edited

Loading